DescribeIpv6Gateways
Description
call the DescribeIpv6Gateways interface to query the created IPv6 gateway.
Request Method
POST
Request Path
/apsara/route/Vpc/DescribeIpv6Gateways
Request Parameters Common Parameters
Name | Location | Type | Required | Sample value | Description |
---|---|---|---|---|---|
PageSize | BODY | integer | No | 10 | Number of entries per page. |
VpcId | BODY | string | No | vpc-123456xscd**** | VPC ID associated with IPv6 gateway. |
PageNumber | BODY | integer | No | 1 | current page number. |
regionId | BODY | string | Yes | No sample value for this parameter. | region id |
Ipv6GatewayId | BODY | string | No | ipv6gw-123456xscd**** | IPv6 gateway ID. |
RegionId | BODY | string | Yes | cn-huhehaote | the region ID to which the IPv6 gateway belongs. You can obtain the region ID by calling the DescribeRegions interface. |
version | BODY | string | No | 2016-01-01 | version of api |
Name | BODY | string | No | ipv6GW | the name of the IPv6 gateway. |
Return data
Name | Type | Sample value | Description |
---|---|---|---|
Status | string | Available | the operating status of the IPv6 gateway. |
Description | string | descriptionforIPv6GW | description information of IPv6 gateway. |
PageSize | integer | 19 | Number of entries per page. |
RequestId | string | E3A06196-3E7C-490D-8F39-CB4B5A0CE8AD | request ID. |
InstanceChargeType | string | PostPaid | IPv6 gateway billing method. |
Ipv6GatewayId | string | ipv6gw-hp3rwmtmfhgisxscd**** | IPv6 gateway ID. |
BusinessStatus | string | Normal | IPv6 gateway status, value: Normal: normal. FinancialLocked: overdue lock. |
Name | string | name | the name of the IPv6 gateway. |
TotalCount | integer | 2 | The number of entries queried. |
VpcId | string | vpc-123456xscd**** | VPC ID associated with IPv6 gateway. |
PageNumber | integer | 1 | current page number. |
ExpiredTime | string | 2018-12-20T14:51:23Z | the expiration time of the IPv6 gateway. |
CreationTime | string | 2018-12-20T14:51:23Z | the creation time of the IPv6 gateway. |
RegionId | string | cn-huhehaote | the region of the IPv6 gateway. |
Spec | string | Small | IPv6 gateway specifications. |
Ipv6Gateways | No sample value for this parameter. | IPv6 gateway details. |
Example
Successful Response example
{
"Status":"Available",
"Description":"descriptionforIPv6GW",
"PageSize":"19",
"RequestId":"E3A06196-3E7C-490D-8F39-CB4B5A0CE8AD",
"InstanceChargeType":"PostPaid",
"Ipv6GatewayId":"ipv6gw-hp3rwmtmfhgisxscd****",
"BusinessStatus":"Normal",
"Name":"name",
"TotalCount":"2",
"VpcId":"vpc-123456xscd****",
"PageNumber":"1",
"ExpiredTime":"2018-12-20T14:51:23Z",
"CreationTime":"2018-12-20T14:51:23Z",
"RegionId":"cn-huhehaote",
"Spec":"Small",
"Ipv6Gateways":""
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}